/*
Copyright 2011 Google Inc. All Rights Reserved.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package org.webtestingexplorer.driver;

import org.openqa.selenium.WebDriver;

/**
 * Creates {@link WebDriver} instances.
 * 
 * @author scott.d.mcmaster@gmail.com (Scott McMaster)
 */
public interface WebDriverFactory {

  /**
   * Called to allow the factory to perform any necessary initialization.
   */
  public void init() throws Exception;
  
  /**
   * Called to allow the factory to shut down politely.
   */
  public void term() throws Exception;
  
  /**
   * Creates a {@link WebDriver} with a proxy.
   */
  WebDriver createWebDriver(WebDriverProxy proxy) throws Exception;
  
  /**
   * Whether or not the {@link WebDriver} should be configured to send requests
   * through a proxy server of our own creation.
   */
  boolean shouldUseProxy();
}
